Skip to content

fix(react-query): update Incorrect Inference of GetDefinedOrUndefinedQueryResult when TData is assignable to CallableFunction #9278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix(react-query): update Incorrect Inference of GetDefinedOrUndefinedQueryResult when TData is assignable to CallableFunction #9278

wants to merge 5 commits into from

Conversation

ViewableGravy
Copy link

@ViewableGravy ViewableGravy commented Jun 14, 2025 •
edited
Loading

Overview

This PR resolves an issue that was brought up in discord where using queryOptions where TQueryFnData was { name: string }, would cause the type of TData on useQueries to be { name: string } instead of { name: string } | undefined.

Upon further investigation into what was causing this, it looks like because InitialData is assignabled to { name: string } when it is a function (since name is a key on CallableFunction in typescript), the type would assume the wrong pathway in the GetDefinedOrUndefinedQueryResult type, resulting in the incorrect return type.

Changing the initial condition from T extends { initialData?: ... } to T extends { initialData: ... } allows us to avoid hitting that pathway altogether and gives the correct type.

Tests

I have updated the tests to ensure this case is correctly tested against, and ensured that existing tests are not affected. I have also slightly restructured the tests specifically testing queryOptions under a describe for better code organization.

Original Issue

Discord Thread: https://discord.com/channels/719702312431386674/1382540005624512532

@ViewableGravy
fix(react-query): update Incorrect Inference of GetDefinedOrUndefined…
34f71fd 
…QueryResult when TData is assignable to CallableFunction

* Only consider the initialData pathway in GetDefinedOrUndefinedQueryResult when the key is defined

* test CallableFunction case for useQueries
@ViewableGravy
Copy link
Author

I can see that my pnpm.lock file shows a large number of changes - however I've ensured that I am using the correct version of pnpm and made sure to run pnpm install directly from the root of the project, so I am unsure why this is the case against master.

Please let me know if I should revert the lock file change, as this should not affect this PR with or without it.

Noting that running pnpm build:all also fails against vue - this change only affects react-query

TkDodo
TkDodo reviewed Jun 19, 2025
View reviewed changes
@TkDodo
Copy link
Collaborator

TkDodo commented Jun 19, 2025

however I've ensured that I am using the correct version of pnpm

you were definitely using the wrong version, I can see that lockfileVersion changed:

- lockfileVersion: '9.0'
+ lockfileVersion: '6.0'

so yeah, definitely the wrong version of pnpm. Please revert, not sure why you’d even commit lockfile changes if you didn’t touch package.json 🤷

@ViewableGravy
Copy link
Author

however I've ensured that I am using the correct version of pnpm

you were definitely using the wrong version, I can see that lockfileVersion changed:

- lockfileVersion: '9.0'
+ lockfileVersion: '6.0'

so yeah, definitely the wrong version of pnpm. Please revert, not sure why you’d even commit lockfile changes if you didn’t touch package.json 🤷

Sorry about the time waste here. I just shouldn't have committed it in the first place. I've reverted that change now

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jun 20, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 3250700.

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ❌ Failed 1h 59m 25s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 28s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-20 17:45:16 UTC

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jun 20, 2025 •
edited
Loading

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@9278

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9278

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9278

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9278

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9278

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@9278

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@9278

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9278

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9278

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@9278

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@9278

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9278

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9278

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@9278

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9278

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9278

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@9278

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9278

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9278

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@9278

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9278

commit: 3250700

TkDodo
TkDodo reviewed Jun 20, 2025
View reviewed changes
Copy link
Collaborator

@TkDodo TkDodo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressing some lint errors

@TkDodo
Copy link
Collaborator

TkDodo commented Jun 20, 2025

we now have a bunch of type errors:

../react-query/src/__tests__/useQueries.test-d.tsx(96,13): error TS2322: Type '{ name: string; }' is not assignable to type 'Promise<Data>'.
  Object literal may only specify known properties, and 'name' does not exist in type 'Promise<Data>'.

@ViewableGravy
Copy link
Author

we now have a bunch of type errors:

../react-query/src/__tests__/useQueries.test-d.tsx(96,13): error TS2322: Type '{ name: string; }' is not assignable to type 'Promise<Data>'.
  Object literal may only specify known properties, and 'name' does not exist in type 'Promise<Data>'.

Didn't get around to this one on the weekend, I'll look into this during the week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TkDodo TkDodo TkDodo approved these changes

Assignees
No one assigned
Labels
package: react-query
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ViewableGravy @TkDodo